home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_emacs.idb / usr / freeware / share / emacs / 19.34 / lisp / goto-addr.el.z / goto-addr.el
Encoding:
Text File  |  1998-10-28  |  8.6 KB  |  238 lines
  1. ;;; goto-addr.el --- click to browse URL or to send to e-mail address
  2.  
  3. ;; Copyright (C) 1995 Free Software Foundation, Inc.
  4.  
  5. ;; Author: Eric Ding <ericding@mit.edu>
  6. ;; Maintainer: Eric Ding <ericding@mit.edu>
  7. ;; Created: 15 Aug 1995
  8. ;; Keywords: mh-e, www, mouse, mail
  9.  
  10. ;; This file is part of GNU Emacs.
  11.  
  12. ;; GNU Emacs is free software; you can redistribute it and/or modify
  13. ;; it under the terms of the GNU General Public License as published by
  14. ;; the Free Software Foundation; either version 2, or (at your option)
  15. ;; any later version.
  16.  
  17. ;; GNU Emacs is distributed in the hope that it will be useful,
  18. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  19. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20. ;; GNU General Public License for more details.
  21.  
  22. ;; You should have received a copy of the GNU General Public License
  23. ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  24. ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  25. ;; Boston, MA 02111-1307, USA.
  26.  
  27. ;;; Commentary:
  28.  
  29. ;; This package allows you to click or hit a key sequence while on a
  30. ;; URL or e-mail address, and either load the URL into a browser of
  31. ;; your choice using the browse-url package, or if it's an e-mail
  32. ;; address, to send an e-mail to that address.  By default, we bind to
  33. ;; the [mouse-2] and the [C-c return] key sequences.
  34.  
  35. ;; INSTALLATION
  36. ;;
  37. ;; To use goto-address in a particular mode (for example, while
  38. ;; reading mail in mh-e), add something like this in your .emacs file:
  39. ;; 
  40. ;; (add-hook 'mh-show-mode-hook 'goto-address)
  41. ;;
  42. ;; By default, goto-address now sends using `mail' instead of `mh-send'.
  43. ;; To use mh-e to send mail, add the following to your .emacs file:
  44. ;;
  45. ;; (setq goto-address-mail-method 'goto-address-send-using-mh-e)
  46. ;;
  47. ;; The mouse click method is bound to [mouse-2] on highlighted URL's or
  48. ;; e-mail addresses only; it functions normally everywhere else.  To bind
  49. ;; another mouse click to the function, add the following to your .emacs
  50. ;; (for example):
  51. ;;
  52. ;; (setq goto-address-highlight-keymap
  53. ;;   (let ((m (make-sparse-keymap)))
  54. ;;     (define-key m [S-mouse-2] 'goto-address-at-mouse)
  55. ;;     m))
  56. ;;
  57.  
  58. ;; BUG REPORTS
  59. ;;
  60. ;; Please send bug reports to me at ericding@mit.edu.
  61.  
  62. ;; Known bugs/features:
  63. ;; * goto-address-mail-regexp only catches foo@bar.org style addressing,
  64. ;;   not stuff like X.400 addresses, etc.
  65. ;; * regexp also catches Message-Id line, since it is in the format of
  66. ;;   an Internet e-mail address (like Compuserve addresses)
  67. ;; * If show buffer is fontified after goto-address-fontify is run
  68. ;;   (say, using font-lock-fontify-buffer), then font-lock face will
  69. ;;   override goto-address faces.
  70.  
  71. ;;; Code:
  72.  
  73. (require 'browse-url)
  74.  
  75. ;;; I don't expect users to want fontify'ing without highlighting.
  76. (defvar goto-address-fontify-p t
  77.   "*If t, URL's and e-mail addresses in buffer are fontified.
  78. But only if `goto-address-highlight-p' is also non-nil.")
  79.  
  80. (defvar goto-address-highlight-p t
  81.   "*If t, URL's and e-mail addresses in buffer are highlighted.")
  82.  
  83. (defvar goto-address-fontify-maximum-size 30000
  84.   "*Maximum size of file in which to fontify and/or highlight URL's.")
  85.  
  86. (defvar goto-address-mail-regexp
  87.   "[-a-zA-Z0-9._]+@\\([-a-zA-z0-9_]+\\.\\)+[a-zA-Z0-9]+"
  88.   "A regular expression probably matching an e-mail address.")
  89.  
  90. (defvar goto-address-url-regexp
  91.   (concat "\\b\\(s?https?\\|ftp\\|file\\|gopher\\|news\\|"
  92.       "telnet\\|wais\\):\\(//[-a-zA-Z0-9_.]+:"
  93.       "[0-9]*\\)?[-a-zA-Z0-9_=?#$@~`%&*+|\\/.,]*"
  94.       "[-a-zA-Z0-9_=#$@~`%&*+|\\/]")
  95.   "A regular expression probably matching a URL.")
  96.  
  97. (defvar goto-address-mail-method
  98.   'goto-address-send-using-mail
  99.   "*Function to compose mail.
  100. Two pre-made functions are `goto-address-send-using-mail' (sendmail);
  101. and `goto-address-send-using-mh-e' (MH-E).")
  102.  
  103. (defvar goto-address-highlight-keymap
  104.   (let ((m (make-sparse-keymap)))
  105.     (define-key m [mouse-2] 'goto-address-at-mouse)
  106.     m)
  107.   "keymap to hold goto-addr's mouse key defs under highlighted URLs.")
  108.  
  109. (defvar goto-address-url-face 'bold
  110.   "*Face to use for URLs.")
  111.  
  112. (defvar goto-address-url-mouse-face 'highlight
  113.   "*Face to use for URLs when the mouse is on them.")
  114.  
  115. (defvar goto-address-mail-face 'italic
  116.   "*Face to use for e-mail addresses.")
  117.  
  118. (defvar goto-address-mail-mouse-face 'secondary-selection
  119.   "*Face to use for e-mail addresses when the mouse is on them.")
  120.  
  121. (defun goto-address-fontify ()
  122.   "Fontify the URL's and e-mail addresses in the current buffer.
  123. This function implements `goto-address-highlight-p'
  124. and `goto-address-fontify-p'."
  125.   (save-excursion
  126.     (let ((inhibit-read-only t)
  127.       (inhibit-point-motion-hooks t)
  128.       (modified (buffer-modified-p)))
  129.       (goto-char (point-min))
  130.       (if (< (- (point-max) (point)) goto-address-fontify-maximum-size)
  131.       (progn
  132.         (while (re-search-forward goto-address-url-regexp nil t)
  133.               (let ((s (match-beginning 0))
  134.                     (e (match-end 0)))
  135.         (and goto-address-fontify-p
  136.              (put-text-property s e 'face goto-address-url-face))
  137.         (put-text-property s e 'mouse-face goto-address-url-mouse-face)
  138.         (put-text-property
  139.          s e 'local-map goto-address-highlight-keymap)))
  140.         (goto-char (point-min))
  141.         (while (re-search-forward goto-address-mail-regexp nil t)
  142.               (let ((s (match-beginning 0))
  143.                     (e (match-end 0)))
  144.         (and goto-address-fontify-p
  145.              (put-text-property s e 'face goto-address-mail-face))
  146.         (put-text-property s e 'mouse-face goto-address-mail-mouse-face)
  147.         (put-text-property
  148.          s e 'local-map goto-address-highlight-keymap)))))
  149.       (and (buffer-modified-p)
  150.        (not modified)
  151.        (set-buffer-modified-p nil)))))
  152.  
  153. ;;; code to find and goto addresses; much of this has been blatantly
  154. ;;; snarfed from browse-url.el
  155.  
  156. ;;;###autoload
  157. (defun goto-address-at-mouse (event)
  158.   "Send to the e-mail address or load the URL clicked with the mouse.
  159. Send mail to address at position of mouse click.  See documentation for
  160. `goto-address-find-address-at-point'.  If no address is found
  161. there, then load the URL at or before the position of the mouse click."
  162.   (interactive "e")
  163.   (save-excursion
  164.     (let ((posn (event-start event)))
  165.       (set-buffer (window-buffer (posn-window posn)))
  166.       (goto-char (posn-point posn))
  167.       (let ((address
  168.          (save-excursion (goto-address-find-address-at-point))))
  169.     (if (string-equal address "")
  170.         (let ((url (browse-url-url-at-point)))
  171.           (if (string-equal url "")
  172.           (error "No e-mail address or URL found")
  173.         (funcall browse-url-browser-function url)))
  174.       (funcall goto-address-mail-method address))))))
  175.  
  176. ;;;###autoload
  177. (defun goto-address-at-point ()
  178.   "Send to the e-mail address or load the URL at point.
  179. Send mail to address at point.  See documentation for
  180. `goto-address-find-address-at-point'.  If no address is found
  181. there, then load the URL at or before point."
  182.   (interactive)
  183.   (save-excursion
  184.     (let ((address (save-excursion (goto-address-find-address-at-point))))
  185.       (if (string-equal address "")
  186.       (let ((url (browse-url-url-at-point)))
  187.         (if (string-equal url "")
  188.         (error "No e-mail address or URL found")
  189.           (funcall browse-url-browser-function url)))
  190.     (funcall goto-address-mail-method address)))))
  191.  
  192. (defun goto-address-find-address-at-point ()
  193.   "Find e-mail address around or before point.
  194. Then search backwards to beginning of line for the start of an e-mail
  195. address.  If no e-mail address found, return the empty string."
  196.   (let ((bol (save-excursion (beginning-of-line) (point))))
  197.     (re-search-backward "[^-_A-z0-9.@]" bol 'lim)
  198.     (if (or (looking-at goto-address-mail-regexp)  ; already at start
  199.         (let ((eol (save-excursion (end-of-line) (point))))
  200.           (and (re-search-forward goto-address-mail-regexp eol 'lim)
  201.            (goto-char (match-beginning 0)))))
  202.     (buffer-substring (match-beginning 0) (match-end 0))
  203.       "")))
  204.  
  205. (defun goto-address-send-using-mh-e (to)
  206.   (require 'mh-comp)
  207.   (mh-find-path)
  208.   (let ((cc (mh-read-address "Cc: "))
  209.     (subject (read-string "Subject: "))
  210.     (config (current-window-configuration)))
  211.     (delete-other-windows)
  212.     (mh-send-sub to cc subject config)))
  213.  
  214. (fset 'goto-address-send-using-mhe 'goto-address-send-using-mh-e)
  215.  
  216. (defun goto-address-send-using-mail (to)
  217.   (mail-other-window nil to)
  218.   (and (goto-char (point-min))
  219.        (end-of-line 2)))
  220.  
  221. ;;;###autoload
  222. (defun goto-address ()
  223.   "Sets up goto-address functionality in the current buffer.
  224. Allows user to use mouse/keyboard command to click to go to a URL
  225. or to send e-mail.
  226. By default, goto-address binds to mouse-2 and C-c RET.
  227.  
  228. Also fontifies the buffer appropriately (see `goto-address-fontify-p' and
  229. `goto-address-highlight-p' for more information)."
  230.   (interactive)
  231.   (local-set-key "\C-c\r" 'goto-address-at-point)
  232.   (if goto-address-highlight-p
  233.       (goto-address-fontify)))
  234.  
  235. (provide 'goto-addr)
  236.  
  237. ;;; goto-addr.el ends here.
  238.